<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>SkeletonHelper - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Object3D.html">Object3D</a> → <a href="Line.html">Line</a> → <a href="LineSegments.html">LineSegments</a> → </p>
	<h1 translate="no">SkeletonHelper</h1>
		<section>
			<header>
				<div class="class-description"><p>A helper object to assist with visualizing a <a href="Skeleton.html">Skeleton</a>.</p></div>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const helper = new THREE.SkeletonHelper( skinnedMesh );
scene.add( helper );
</code></pre></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="SkeletonHelper" translate="no">new <a href="#SkeletonHelper">SkeletonHelper</a><span class="signature">( object : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new skeleton helper.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>object</strong>
									</td>
									<td class="description last">
										<p>Usually an instance of <a href="SkinnedMesh.html">SkinnedMesh</a>. However, any 3D object
can be used if it represents a hierarchy of bones (see <a href="Bone.html">Bone</a>).</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="bones" translate="no">.<a href="#bones">bones</a><span class="type-signature"> : Array.&lt;<a href="Bone.html">Bone</a>></span> </h3>
					<div class="description">
						<p>The list of bones that the helper visualizes.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="isSkeletonHelper" translate="no">.<a href="#isSkeletonHelper">isSkeletonHelper</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>This flag can be used for type testing.</p>
						<p>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="root" translate="no">.<a href="#root">root</a><span class="type-signature"> : <a href="Object3D.html">Object3D</a></span> </h3>
					<div class="description">
						<p>The object being visualized.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="dispose" translate="no">.<a href="#dispose">dispose</a><span class="signature">()</span> </h3>
					<div class="method">
						<div class="description">
							<p>Frees the GPU-related resources allocated by this instance. Call this
method whenever this instance is no longer used in your app.</p>
						</div>
					</div>
					<h3 class="name name-method" id="setColors" translate="no">.<a href="#setColors">setColors</a><span class="signature">( color1 : <span class="param-type"><a href="Color.html">Color</a></span>, color2 : <span class="param-type"><a href="Color.html">Color</a></span> )</span><span class="type-signature"> : <a href="SkeletonHelper.html">SkeletonHelper</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Defines the colors of the helper.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>color1</strong>
									</td>
									<td class="description last">
										<p>The first line color for each bone.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>color2</strong>
									</td>
									<td class="description last">
										<p>The second line color for each bone.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this helper.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/helpers/SkeletonHelper.js" translate="no" target="_blank" rel="noopener">src/helpers/SkeletonHelper.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>